Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update style guidelines in CONTRIBUTING.md #6521

Merged
merged 3 commits into from
Nov 21, 2024

Conversation

emmanuel-ferdman
Copy link
Contributor

@emmanuel-ferdman emmanuel-ferdman commented Nov 20, 2024

Why is this the best possible solution? Were any other approaches considered?

Small PR - commit 1f71ade moved the CONTRIBUTING.md file to docs. But still, the CONTRIBUTING.md does not provide the style guidelines. The CODE-GUIDELINES.md does, so this PR updates the CONTRIBUTING.md to reference CODE-GUIDELINES.md.

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Do we need any specific form for testing your changes? If so, please attach one.

Does this change require updates to documentation? If so, please file an issue here and include the link below.

Before submitting this PR, please make sure you have:

  • added or modified tests for any new or changed behavior
  • run ./gradlew connectedAndroidTest (or ./gradlew testLab) and confirmed all checks still pass
  • added a comment above any new strings describing it for translators
  • added any new strings with date formatting to DateFormatsTest
  • verified that any code or assets from external sources are properly credited in comments and/or in the about file.
  • verified that any new UI elements use theme colors. UI Components Style guidelines

Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
@emmanuel-ferdman emmanuel-ferdman changed the title Update CONTRIBUTING.md reference Update style guidelines in CONTRIBUTING.md Nov 20, 2024
@seadowg seadowg self-requested a review November 21, 2024 11:05
docs/CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
@emmanuel-ferdman
Copy link
Contributor Author

@seadowg thank you for the review, fixed 😄

Copy link
Member

@seadowg seadowg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much @emmanuel-ferdman!

@seadowg seadowg merged commit 9bcfd13 into getodk:master Nov 21, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants